<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
  <head>
  <meta http-equiv="content-type" content="text/html; charset=windows-1250">
  <meta name="generator" content="PSPad editor, www.pspad.com">
  <title>ISubscribe quick-start</title>
    <style type="text/css">

	/*#ISubscribe_Help{font-size: 12pt;}*/
  #ISubscribe_Help h1{font-size: 1.8em; font-weight: bold }
  #ISubscribe_Help h2{font-size: 1.5em; font-weight: bold }
  #ISubscribe_Help h3{font-size: 1.4em; font-weight: bold }
  #ISubscribe_Help h4{font-size: 1.3em; font-weight: bold }
  #ISubscribe_Help h5{font-size: 1.2em; font-weight: bold }
  #ISubscribe_Help h6{font-size: 1.1em; font-weight: bold }


  #ISubscribe_Help p{
      margin: 8px;
  }
  #ISubscribe_Help code{
      margin: 8px;
  }
  #ISubscribe_Help h2, #ISubscribe_Help h3{
      margin: 16px 8px 0 8px;
  }
  #ISubscribe_Help ol li{
      list-style-type: decimal;
      margin: 4px 8px;
      padding: 0;
  }
  #ISubscribe_Help ol ol li{
      list-style-type: upper-roman;
  }
  #ISubscribe_Help ul li, #ISubscribe_Help ol ul li{
      list-style-type: disc;
  }
  #ISubscribe_Help .important{
      border: solid 3px red;
      color: red;
      margin: 8px;
      padding: 8px;
      font-weight: bold;
  }
  #ISubscribe_Help .example{
      border: solid 1px #CCC;
      background-color: #EFEFEF;
      padding: 8px;
  }
  #ISubscribe_Help .example code{
      margin: 0;
  }
  </style>
  </head>
  <body>
  <div id="ISubscribe_Help">
<h1>ISubscribe Quick-Start</h1>

<h2>What does it do?</h2>
<p>
	ISubscribe works with IUsers to sell subscriptions to IUsers groups. Visitors to your site
	can pay by credit card gateway to purchase access to restricted content on your site.
</p>

<h2>How does it work?</h2>
<p>
	You first create a group in IUsers which will enable you to hide pages and blocks of content
	on your site, making them visible only to members of that group. You then create subscription
	packages in ISubscribe which upon successful payment, will assign the designated group
	to the user account. For example, you might be selling 1 year "Bronze" subscriptions.
	ISubscribe will handle the expiration of subscriptions too. When the subscription period has elapsed,
	ISubscribe will remove the user to group association so the user will not be able
	to access the material until they have purchased another subscription.
</p>

<h2>Example of use</h2>
<p>In this example, we are selling Bronze, Silver and Gold subscriptions for periods of 365 days.</p>
<ol>
	<li><h3>Create 3 groups in IUsers</h3>
		<ol>
			<li><h4>Bronze group</h4>
			<ul>
				<li>Keyname: bronze</li>
				<li>Title: Bronze Membership</li>
			</ul></li>
			<li><h4>Silver group</h4>
			<ul>
				<li>Keyname: silver</li>
				<li>Title: Silver Membership</li>
			</ul></li>
			<li><h4>Gold group</h4>
			<ul>
				<li>Keyname: gold</li>
				<li>Title: Gold Membership</li>
			</ul></li>
		</ol>
	</li>
	<li><h3>Create pages in your website to reflect the access levels</h3>
		<ol>
			<li><h4>Bronze page</h4>
				<ul>
					<li>"bronze" group has access</li>
					<li>"silver" group has access</li>
					<li>"gold" group has access</li>
				</ul>
			</li>
			<li><h4>Silver page</h4>
				<ul>
					<li>"silver" group has access</li>
					<li>"gold" group has access</li>
				</ul>
			</li>
			<li><h4>Gold page</h4>
				<ul>
					<li>"gold" group has access</li>
				</ul>
			</li>
		</ol>
	</li>
	<li>
		<h3>Create 3 new subscriptions in ISubscribe</h3>
		<p>Note: You may add your own currencies in the currencies tab, but be sure
				to use the correct currency key so the payment gateway can recognise it.</p>
				<p>Note: The group drop-menu for each price provides a means to sell upgrades.
				It is also possible to create a new subscription and show a conditional link with
				the IUsers "showto" tag, take your preference.</p>
		<ol>
			<li><h4>Bronze Membership</h4>
				<h5>Subscription details</h5>
				<ul>
					<li>Keyname: 1yr-bronze</li>
					<li>Title: 1 Year Bronze Membership</li>
					<li>Groups to grant: Bronze Membership</li>
					<li>Duration: 365</li>
				</ul>
				<h5>Prices for new subscription</h5>
				<ol>
					<li><h6>For public members</h6>
						<ul>
							<li>Price: $30</li>
							<li>Currency: New Zealand Dollars</li>
							<li>Group: Public</li>
						</ul>
					</li>
				</ol>
			</li>
			<li><h4>Silver Membership</h4>
				<h5>Subscription details</h5>
				<ul>
					<li>Keyname: 1yr-silver</li>
					<li>Title: 1 Year Silver Membership</li>
					<li>Groups to grant: Silver Membership</li>
					<li>Duration: 365</li>
				</ul>
				<h5>Prices for new subscription</h5>
				<ol>
					<li><h6>For public members</h6>
						<ul>
							<li>Price: $60</li>
							<li>Currency: New Zealand Dollars</li>
							<li>Group: Public</li>
						</ul>
					</li>
					<li><h6>For bronze members</h6>
						<ul>
							<li>Price: $30</li>
							<li>Currency: New Zealand Dollars</li>
							<li>Group: Bronze</li>
						</ul>
					</li>
				</ol>
			</li>
			<li><h4>Gold Membership</h4>
				<h5>Subscription details</h5>
				<ul>
					<li>Keyname: 1yr-gold</li>
					<li>Title: 1 Year Gold Membership</li>
					<li>Groups to grant: Gold Membership</li>
					<li>Duration: 365</li>
				</ul>
				<h5>Prices for new subscription</h5>
				<ol>
					<li><h6>For public members</h6>
						<ul>
							<li>Price: $90</li>
							<li>Currency: New Zealand Dollars</li>
							<li>Group: Public</li>
						</ul>
					</li>
					<li><h6>For bronze members</h6>
						<ul>
							<li>Price: $60</li>
							<li>Currency: New Zealand Dollars</li>
							<li>Group: Bronze</li>
						</ul>
					</li>
					<li><h6>For silver members</h6>
						<ul>
							<li>Price: $30</li>
							<li>Currency: New Zealand Dollars</li>
							<li>Group: Silver</li>
						</ul>
					</li>
				</ol>
			</li>
		</ol>
	</li>

	<li>
	<h3>Create the purchase page</h3>
	<ul>
		<li>Title: Purchase Subscription</li>
		<li>Alias: purchase-subscription</li>
		<li>Content: {cms_module module="ISubscribe" action="purchase-subscription"}</li>
		<li>Show in menu: no</li>
		<li>Cacheable: no</li>
	</ul>
	</li>
	<li>
	   <h3>Set the purchase page on the config tab</h3>
	</li>
	<li><h3>Create 3 links in your template, homepage or wherever you want to advertise subscriptions</h3>
		<ul>
		<li>
			<code>
				{hidefrom groups="bronze,silver,gold"}
					{cms_module module="ISubscribe" action="make-link" subscription="1yr-bronze"}
				{/hidefrom}
			</code>
		</li>
		<li>
			<code>
				{hidefrom groups="silver,gold"}
					{cms_module module="ISubscribe" action="make-link" subscription="1yr-silver"}
				{/hidefrom}
			</code>
		</li>
		<li>
			<code>
				{hidefrom groups="gold"}
					{cms_module module="ISubscribe" action="make-link" subscription="1yr-gold"}
				{/hidefrom}
			</code>
		</li>
		</ul>
		<p>Note: Optional parameters:
		<ul>
			<li>content: is what goes between the opening and closing "a" tags, can be html</li>
			<li>class: class names that you may want for styling</li>
			<li>id: html id for this link</li>
		</ul>
		</p>

	</li>

	<li><h3>Configure your payment gateways</h3>
	<ul>
		<li>
			<h4>For non-programmers:</h4>
			<ul>
				<li>You can install new payment gateways, but you must know the class name. Ask your
				programmer for this info if you don't know how to get it.
				</li>
				<li>You can configure the username, account numbers and passwords that are required
				for your gateway to authenticate with your gateway provider. These details will
				vary depending on the payment gateway.</li>
			</ul>
			<h4>For programmers</h4>
			<ul>
				<li>The payment gateway system is modular, it is designed for programmers to extend
				easily. Please read the bundled payment gateway code for an example of how you can create
				your own, and <strong>please contribute</strong> - contact me and I will include your
				gateway in future releases.</li>
				<li>
				Payment gateways are classes that extend the common class. There are two types of payment
				gateway: onsite and offsite. An offsite gateway redirects to a 3rd party website to
				process the payment. The onsite gateway takes the credit card details in a form on
				your website and processes the payment without the user ever leaving your website.
				</li>
				<li>
				Payment gateway class files are stored in /modules/ISubscribe/gateways. An
				instance of the class is serialized and ecrypted, then stored in the database table
				"prefix_isubscribe_payment_gateways".
				Please use the installation tab to install your gateway. While developing, you may need
				to delete your serialized object from the "obj" cell in the database to refresh the
				constructor data.</li>
			</ul>
		</li>
	</ul>

	</li>
	
	<li>
	 <h2>Set up the system cron</h2>
	 <p>Permissions get revoked when subscriptions expire. For this to happen,
   you must run a cron script periodically, usually once a day will suffice.</p>
   <ol>
    <li>Create a page in your CMS and hide in menu.</li>
    <li>Enter this tag: <code>{cms_module module="ISubscribe" action="cron"}</li>
    <li>Set a system cron to trigger this page every day, the EzCrons module can
    do this for you.</li>
   </ol>
	</li>
	
	<li>
	   <h3>Notifications</h3>
	   <p>You can schedule notifications to be sent to subscribers when their subscription
	   is nearing its expiration. Usually you would send one 10-14 days before it happens,
	   then another 1-2 days prior to remind them. You might like to set a special offer of
	   un-advertised subscription with a discount and put a link to it in the notification.
	   The notification parses Smarty tags so you would use the make-link action.
       </p>
	</li>
	
	<li>
	   <h3>Test</h3>
	   <p>Set up a $1 subscription and test that it is working as expected</p>
	</li>


</ol>

</div>

  </body>
</html>